Skip to content

docs: put the GitHub App first on the org profile - #70

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp
Oct 20, 2026
Merged

docs: put the GitHub App first on the org profile#70
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 20, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Member

Before: the org profile at github.com/commit-check showed the App only as the last row of the family table. The quick start offered the pre-commit hook and the Action, the diagram's CI column read "GitHub CI / Action", and the pre-commit example pinned v2.19.1.

After: the quick start opens with the App's install link (free for public repositories and personal accounts, no workflow file), then "To run the checks yourself instead:" before the two YAML examples. The App is the first row of the family table, the diagram's column reads "GitHub App / or Action", and the example pins v2.19.2.

Before After
Quick start pre-commit and Action YAML only App install link first, then the YAML
Family table App in the last row App in the first row
Diagram GitHub CI / Action GitHub App / or Action
pre-commit rev v2.19.1 v2.19.2

How: one file, profile/README.md.

Summary by CodeRabbit

  • Documentation
    • Updated the README to identify the GitHub App as the GitHub integration.
    • Added instructions for installing the App to enable organization- or account-wide checks without a workflow file.
    • Updated the pre-commit example to version 2.19.2.
    • Reordered the product-family table to list the GitHub App first.

@shenxianpeng
docs: put the GitHub App first on the org profile
db1d51e 
The App installs today and needs no workflow file, so the profile now
offers it first: the quick start opens with the install link, the family
table lists the App first, and the diagram's CI column reads "GitHub App
or Action". The pre-commit example pins v2.19.2, the current release.
@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •
edited
Loading

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 9b3b9580-f357-4758-962c-6f0ca4765ba2
📥 Commits

Reviewing files that changed from the base of the PR and between 6d9e30e and db1d51e.

📒 Files selected for processing: 1
  • profile/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

The README now identifies the GitHub App alongside the Action, adds installation guidance for organization- or account-wide checks, updates the pre-commit revision, and lists the GitHub App first in the product-family table.

Changes: GitHub Integration README

Layer / File(s) Summary
Integration overview and setup
profile/README.md		 The integration diagram identifies the GitHub App or Action. The quick-start section adds App installation guidance and updates the pre-commit revision to v2.19.2. The product-family table lists the GitHub App first.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to db1d5

The PR contains documentation-only updates with no identified merge-blocking risk.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title accurately identifies the main change: presenting the GitHub App first on the organization profile.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Oct 20, 2026

Copy link
Copy Markdown

Commit Check

✅ All 3 checks passed

Show all 3 checks 
Commit message
  ✔ PR title (docs: put the GitHub App first on the org profile)
  ✔ Commit 1/1 (db1d51e) (docs: put the GitHub App first on the org profile)
Branch
  ✔ Branch (claude/project-thread-pofwgp)

commit-check 2.19.0 · Rules reference

@shenxianpeng
shenxianpeng merged commit b1a801a into main Oct 20, 2026
4 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-pofwgp branch October 20, 2026 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shenxianpeng